API docs by Redocly

Heseya Store API (4.0.0)

Download OpenAPI specification:Download

IMPORTANT! You need specific permissions to access each endpoint: https://escl24.atlassian.net/wiki/spaces/HES/pages/6476169217/Autoryzacja

Analytics

Summary of all payments over a period of time

Returns total amount and count of payments. By default period is last year. Results are grouped in specified time frames.

Authorizations:
BearerAuth
query Parameters
from
string
Example: from=2021-03-23

date datetime or timestamp by default in UTC+0; required if 'to' is set

to
string
Example: to=2021-04-23 15:37

date datetime or timestamp by default in UTC+0

group
string
Example: group=total

total/yearly/monthly/daily/hourly

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Apps

All registered app list

Authorizations:
BearerAuth
query Parameters
object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

install a new app

Authorizations:
BearerAuth
Request Body schema: application/json
url
required
string

Url of the applications microfrontend configuration page

name
string

Name of the app

licence_key
string

Licence key allowing to install application

allowed_permissions
required
Array of strings

Permissions granted to the app

public_app_permissions
Array of strings

App permissions granted to unauthenticated users

object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "url": "https://microfront.app.heseya.com",
  • "name": "Super App",
  • "licence_key": "6v5e*B^%e8n76rn869r6n9r75nim76E&%nm996f7e87m",
  • "allowed_permissions": [
    ],
  • "public_app_permissions": [
    ],
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

show an app

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete app

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
query Parameters
force
boolean

Force removal of the app

Responses

Audits

list changes for object

Authorizations:
BearerAuth
path Parameters
object
required
string
Example: products
id
required
string
Example: 026bc5f6-8373-4aeb-972e-e78d72a67121

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Auth

Login

Authorizations:
BearerAuth
Request Body schema: application/json
email
required
string
password
required
string
code
string

Responses

Request samples

Content type
application/json
{
  • "email": "admin@example.com",
  • "password": "secret",
  • "code": "XyDZR-M9GWZ"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Register new user

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
email
string
password
string
birthday_date
string <date>
phone
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "Registered user",
  • "email": "admin@example.com",
  • "password": "secret",
  • "birthday_date": "2000-01-01",
  • "phone": "+48123456789",
  • "consents": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Logout

Authorizations:
BearerAuth

Responses

Reset password

Authorizations:
BearerAuth
Request Body schema: application/json
redirect_url
string
email
string

Responses

Request samples

Content type
application/json
{}

Checks if token belongs to user with email

Authorizations:
BearerAuth
path Parameters
token
required
string
Example: be55ec43d8f58c85b333605f06be1163091a697f2460d86755ca4324cf56cccc

User token

email
required
string
Example: test@test.test

User email

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

save the reset password

Authorizations:
BearerAuth
Request Body schema: application/json
token
string
email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "email": "admin@example.com",
  • "password": "string"
}

Change password

Authorizations:
BearerAuth
Request Body schema: application/json
password
string
password_new
string

Responses

Request samples

Content type
application/json
{
  • "password": "secret",
  • "password_new": "xsw@!QAZ34"
}

Refresh access and identity tokens

Authorizations:
BearerAuth
Request Body schema: application/json
refresh_token
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get your own user or app resource

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

edit your own user resource

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
birthday_date
string <date>
phone
string
object
object (Preferences)

Responses

Request samples

Content type
application/json
{
  • "name": "Test User",
  • "birthday_date": "2000-01-01",
  • "phone": "+48123456789",
  • "consents": {
    },
  • "preferences": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Add shipping address to user

Authorizations:
BearerAuth
Request Body schema: application/json
default
required
boolean
name
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "name": "Home",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update user shipping address

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 026bc5f6-8373-4aeb-972e-e78d72a67121
Request Body schema: application/json
default
required
boolean
name
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "name": "Home",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete user shipping address

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 026bc5f6-8373-4aeb-972e-e78d72a67121

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add billing address to user

Authorizations:
BearerAuth
Request Body schema: application/json
default
required
boolean
name
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "name": "Home",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update user billing address

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 026bc5f6-8373-4aeb-972e-e78d72a67121
Request Body schema: application/json
default
required
boolean
name
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "name": "Home",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete user billing address

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 026bc5f6-8373-4aeb-972e-e78d72a67121

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

get profile resource of unauthenticated user

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get profile resource from identity token

Authorizations:
BearerAuth
path Parameters
identity_token
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

2FA Setup

Authorizations:
BearerAuth
Request Body schema: application/json
type
string

app | email

Responses

Request samples

Content type
application/json
{
  • "type": "app"
}

Response samples

Content type
application/json
{}

2FA Confirm

Authorizations:
BearerAuth
Request Body schema: application/json
code
string

Responses

Request samples

Content type
application/json
{
  • "code": 123456
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

2FA Create recovery codes

Authorizations:
BearerAuth
Request Body schema: application/json
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "secret"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

2FA Remove

Authorizations:
BearerAuth
Request Body schema: application/json
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "secret"
}

List of providers

Authorizations:
BearerAuth
path Parameters
active
required
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Merge standard registered user with provider user

Authorizations:
BearerAuth
Request Body schema: application/json
merge_token
string

Responses

Request samples

Content type
application/json
{
  • "merge_token": "38v92867932v48937y4"
}

Gets provider

Authorizations:
BearerAuth
path Parameters
AuthProviderKey
required
string
Enum: "facebook" "google" "apple" "github" "gitlab" "bitbucket" "linkedin"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates provider

Authorizations:
BearerAuth
path Parameters
AuthProviderKey
required
string
Enum: "facebook" "google" "apple" "github" "gitlab" "bitbucket" "linkedin"
Request Body schema: application/json
client_id
string
client_secret
string
active
boolean

Responses

Request samples

Content type
application/json
{
  • "client_id": "38v92867932v48937y4",
  • "client_secret": "209-387vn20hfj",
  • "active": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Login

Authorizations:
BearerAuth
path Parameters
AuthProviderKey
required
string
Enum: "facebook" "google" "apple" "github" "gitlab" "bitbucket" "linkedin"
Request Body schema: application/json
return_url
string

Must be same as the return_url used in the /auth/providers/{provider}/redirect endpoint and contains query params received from providers

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Redirect to auth provider login

Authorizations:
BearerAuth
path Parameters
AuthProviderKey
required
string
Enum: "facebook" "google" "apple" "github" "gitlab" "bitbucket" "linkedin"
Request Body schema: application/json
return_url
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

User 2FA Remove

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

Shipping

list of all countries

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

list shipping methods by filters

Authorizations:
BearerAuth
query Parameters
country
string
Example: country=DE
cart_value
number
Example: cart_value=1200

cart total you want to display shipping price for

object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new shipping method

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string
public
boolean
block_list
boolean
payment_methods
Array of strings
countries
Array of strings
required
Array of objects
shipping_time_min
required
number
shipping_time_max
required
number
Array of objects
integration_key
string
shipping_type
string
Enum: "digital" "address" "point" "point-external"
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "dpd",
  • "public": true,
  • "block_list": true,
  • "payment_methods": [
    ],
  • "countries": [
    ],
  • "price_ranges": [
    ],
  • "shipping_time_min": 2,
  • "shipping_time_max": 3,
  • "shipping_points": [
    ],
  • "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "shipping_type": "digital",
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete shipping method

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: d1365285-ad58-48da-88e2-99e9f4c0800d

Responses

update shipping method

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: d1365285-ad58-48da-88e2-99e9f4c0800d
Request Body schema: application/json
name
string
public
boolean
block_list
boolean
payment_methods
Array of strings
countries
Array of strings
Array of objects
shipping_time_min
number
shipping_time_max
number
Array of objects
integration_key
string

Responses

Request samples

Content type
application/json
{
  • "name": "dpd",
  • "public": true,
  • "block_list": true,
  • "payment_methods": [
    ],
  • "countries": [
    ],
  • "price_ranges": [
    ],
  • "shipping_time_min": 2,
  • "shipping_time_max": 3,
  • "shipping_points": [
    ],
  • "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reorder shipping method

Authorizations:
BearerAuth
Request Body schema: application/json
shipping_methods
Array of strings

Responses

Request samples

Content type
application/json
{
  • "shipping_methods": [
    ]
}

Deposits

list deposits

Authorizations:
BearerAuth
query Parameters
object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

list item deposits

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

add new deposit

Authorizations:
BearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
quantity
required
number
shipping_time
integer
shipping_date
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "quantity": "12.5",
  • "shipping_time": 5,
  • "shipping_date": "2021-09-13T11:11"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Discounts

get all sales

Authorizations:
BearerAuth
query Parameters
search
string
description
string
for_role
string
ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new sale

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string
description
string
type
required
string
Enum: "amount" "percentage"
value
required
number
priority
required
number
target_type
required
string
Enum: "order-value" "products" "shipping-price" "cheapest-product"
target_is_allow_list
required
boolean
active
required
boolean
Array of objects (DiscountConditions_ConditionGroup)
target_products
Array of strings
target_sets
Array of strings
target_shipping_methods
Array of strings
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "Black",
  • "description": "Black Weekend 2021",
  • "type": "amount",
  • "value": "50",
  • "priority": 1,
  • "target_type": "order-value",
  • "target_is_allow_list": true,
  • "active": true,
  • "condition_groups": [
    ],
  • "target_products": [
    ],
  • "target_sets": [
    ],
  • "target_shipping_methods": [
    ],
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

show Sale

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 026bc5f6-8373-4aeb-972e-e78d72a67121

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete sale

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4

Responses

update sale

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4
Request Body schema: application/json
name
required
string
description
string
type
required
string
Enum: "amount" "percentage"
value
required
number
priority
required
number
target_type
required
string
Enum: "order-value" "products" "shipping-price" "cheapest-product"
target_is_allow_list
required
boolean
active
required
boolean
Array of objects (DiscountConditions_ConditionGroup)
target_products
Array of strings
target_sets
Array of strings
target_shipping_methods
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "Black",
  • "description": "Black Weekend 2021",
  • "type": "amount",
  • "value": "50",
  • "priority": 1,
  • "target_type": "order-value",
  • "target_is_allow_list": true,
  • "active": true,
  • "condition_groups": [
    ],
  • "target_products": [
    ],
  • "target_sets": [
    ],
  • "target_shipping_methods": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get all Coupons

Authorizations:
BearerAuth
query Parameters
search
string
description
string
code
string
for_role
string
ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new Coupon

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string
description
string
type
required
string
Enum: "amount" "percentage"
value
required
number
priority
required
number
target_type
required
string
Enum: "order-value" "products" "shipping-price" "cheapest-product"
target_is_allow_list
required
boolean
active
boolean
code
required
string
Array of objects
target_products
Array of strings
target_sets
Array of strings
target_shipping_methods
Array of strings
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "Black",
  • "description": "Black Weekend 2021",
  • "type": "amount",
  • "value": "50",
  • "priority": 1,
  • "target_type": "order-value",
  • "target_is_allow_list": true,
  • "active": true,
  • "code": "83734AE",
  • "condition_groups": [
    ],
  • "target_products": [
    ],
  • "target_sets": [
    ],
  • "target_shipping_methods": [
    ],
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

show Coupon

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 026bc5f6-8373-4aeb-972e-e78d72a67121

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete Coupon

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4

Responses

update Coupon

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4
Request Body schema: application/json
name
required
string
description
string
type
required
string
Enum: "amount" "percentage"
value
required
number
priority
required
number
target_type
required
string
Enum: "order-value" "products" "shipping-price" "cheapest-product"
target_is_allow_list
required
boolean
active
boolean
code
required
string
Array of objects (DiscountConditions_ConditionGroup)
target_products
Array of strings
target_sets
Array of strings
target_shipping_methods
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "Black",
  • "description": "Black Weekend 2021",
  • "type": "amount",
  • "value": "50",
  • "priority": 1,
  • "target_type": "order-value",
  • "target_is_allow_list": true,
  • "active": true,
  • "code": "83734AE",
  • "condition_groups": [
    ],
  • "target_products": [
    ],
  • "target_sets": [
    ],
  • "target_shipping_methods": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

show Coupon

Authorizations:
BearerAuth
path Parameters
code
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

WebHooks

list with logs of failed webhooks

Authorizations:
BearerAuth
query Parameters
status
number

Status code search

event
string

Event search

web_hook_id
string

Webhook ID search

successful
boolean

Is successful

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

list available events

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

list webhooks by filters

Authorizations:
BearerAuth
query Parameters
name
string

Name search

url
string

URL search

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new webhook

Authorizations:
BearerAuth
Request Body schema: application/json
name
string

Displayed webhook name

url
string

Displayed webhook url

secret
string

Displayed webhook secret

with_issuer
boolean

Whether issuer is visible in WebHookEvent.

with_hidden
boolean

Whether hidden data are visible in WebHookEvent.

events
Array of strings

List of WebHook events

Responses

Request samples

Content type
application/json
{
  • "name": "WebHook name",
  • "url": "https://app.heseya.com",
  • "secret": "secret",
  • "with_issuer": true,
  • "with_hidden": true,
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

show webhook

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4

Name search

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete webhook

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4

Responses

update webhook

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4
Request Body schema: application/json
name
string

Displayed webhook name

url
string

Displayed webhook url

secret
string

Displayed webhook secret

with_issuer
boolean

Whether issuer is visible in WebHookEvent.

with_hidden
boolean

Whether hidden data are visible in WebHookEvent.

events
Array of strings

List of WebHook events

Responses

Request samples

Content type
application/json
{
  • "name": "WebHook name",
  • "url": "https://app.heseya.com",
  • "secret": "secret",
  • "with_issuer": true,
  • "with_hidden": true,
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Filters

gets sets filters

Authorizations:
BearerAuth
query Parameters
sets[]
string
Example: sets[]=sets[]=026bc5f6-8373-4aeb-972e-e78d72a67121&sets[]=026bc5f6-8373-4aeb-972e-e78d72a67121

Array of sets ids to search attributes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Items

list items

Authorizations:
BearerAuth
query Parameters
search
string

Full text search

name
string

Name search

sku
string

Sku search

sort
string
Example: sort=name:asc,created_at:desc,updated_at:asc,sku:desc,quantity:desc

Sorting string. Cannot sort by quantity if field day is present

sold_out
boolean

Items sold out search. Cannot search by this field if field day is present

day
string <date | date-time>

Items status as at day. If present cannot search by sold_out field and sort by quantity. If only date is provided then default time is set to 23:59:59

object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new item

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string
sku
required
string
unlimited_shipping_time
integer
unlimited_shipping_date
string <date-time>
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "Chain",
  • "sku": "K121",
  • "unlimited_shipping_time": 5,
  • "unlimited_shipping_date": "2021-09-13T11:11",
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

view item

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete item

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4

Responses

update item

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4
Request Body schema: application/json
name
string
sku
string
unlimited_shipping_time
integer
unlimited_shipping_date
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "Chain",
  • "sku": "K121",
  • "unlimited_shipping_time": 5,
  • "unlimited_shipping_date": "2021-09-13T11:11"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Media

List of media

Authorizations:
BearerAuth
query Parameters
type
string
Example: type=photo
has_relationships
boolean
ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

upload new file

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
file
string <binary>

File. Accepted extensions: jpeg, png, gif, bmp, svg, mp4, webm, ogg, avi, mov, wmv

slug
string
alt
string
metadata.*
string

asterisk has to be replaced with metadata key

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update media

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
alt
string

Media alt description

slug
string

Media slug without domain and file extension

Responses

Request samples

Content type
application/json
{
  • "alt": "Example media alt description",
  • "slug": "test-slug"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete media

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Orders

orders list

Authorizations:
BearerAuth
query Parameters
search
string

Full text search.

sort
string
Example: sort=code:asc,created_at:desc,id:asc,email:desc,summary:desc

Sorting string.

status_id
string

Status UUID

shipping_method_id
string

Shipping Method UUID

digital_shipping_method_id
string

Digital Shipping Method UUID

paid
boolean

Is order paid

from
string <date-time>

Date datetime from

to
string <date-time>

Date datetime to

object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new order

Authorizations:
BearerAuth
Request Body schema: application/json
email
required
string
comment
string
shipping_method_id
string
digital_shipping_method_id
string
required
Array of objects
object (Addresses_Address)
required
object (Addresses_Address)
coupons
Array of strings
invoice_requested
boolean
sale_ids
Array of strings
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "email": "admin@example.com",
  • "comment": "asap plz",
  • "shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "digital_shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "items": [
    ],
  • "shipping_place": {
    },
  • "billing_address": {
    },
  • "coupons": [
    ],
  • "invoice_requested": true,
  • "sale_ids": [
    ],
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

order view

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update order

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
email
string
comment
string
shipping_number
string
shipping_method_id
string
digital_shipping_method_id
string
object (Addresses_Address)
object (Addresses_Address)
invoice_requested
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "admin@example.com",
  • "comment": "asap plz",
  • "shipping_number": "630552359128340015809770",
  • "shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "digital_shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "shipping_place": {
    },
  • "billing_address": {
    },
  • "invoice_requested": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

public order view

Authorizations:
BearerAuth
path Parameters
code
required
string
Example: D3PT88

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

change order status

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
status_id
integer

Responses

Request samples

Content type
application/json
{
  • "status_id": 0
}

create shipping list webhook

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
package_template_id
string

Responses

Request samples

Content type
application/json
{
  • "package_template_id": "1c8705ce-5fae-4468-b88a-8784cb5414a0"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Send email with order products urls

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

user orders list

Authorizations:
BearerAuth
query Parameters
search
string

Full text search.

sort
string
Example: sort=code:asc,created_at:desc,id:asc,email:desc,summary:desc

Sorting string.

status_id
string

Status UUID

shipping_method_id
string

Shipping Method UUID

from
string <date-time>

Date datetime from

to
string <date-time>

Date datetime to

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

user order view

Authorizations:
BearerAuth
path Parameters
code
required
string
Example: 5B32FD

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

User ordered products list

Authorizations:
BearerAuth
query Parameters
shipping_digital
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add document

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: multipart/form-data
name
string
file
string <binary>
type
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete document

Authorizations:
BearerAuth
path Parameters
order_id
required
string
Example: d1365285-ad58-48da-88e2-99e9f4c0800d
doc_id
required
string
Example: d1365285-ad58-48da-88e2-99e9f4c0800d

Responses

downloads document

Authorizations:
BearerAuth
path Parameters
order_id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4
doc_id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4

Responses

send documents

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
uuid
Array of strings

Responses

Request samples

Content type
application/json
{
  • "uuid": [
    ]
}

Add links to order products

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4
order_product_id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
is_delivered
boolean
object

Object keys are link names and values are links

Responses

Request samples

Content type
application/json
{}

validate cart items and coupons

Authorizations:
BearerAuth
Request Body schema: application/json
required
Array of objects (CartItem)

List of products

coupons
Array of strings
shipping_method_id
string
digital_shipping_method_id
string

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "coupons": [
    ],
  • "shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "digital_shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

redirect to payment

Authorizations:
BearerAuth
path Parameters
code
required
string
payment_method
required
string
Request Body schema: application/json
continue_url
string

URL that the buyer will be redirected to, after making payment

Responses

Request samples

Content type
application/json
{
  • "continue_url": "string"
}

Response samples

Content type
application/json
{}

manualy create fulfilled order payment

Authorizations:
BearerAuth
path Parameters
code
required
string

Responses

Response samples

Content type
application/json
{}

Packages

list packages

Authorizations:
BearerAuth
query Parameters
object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new package

Authorizations:
BearerAuth
Request Body schema: application/json
id
string
name
string
wieght
number

Weight in kg

width
integer

Width in cm

height
integer

Height in cm

depth
integer

Depth in cm

object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "5fb4a472-b5fd-4e9a-a4ee-bf42bde86a73",
  • "name": "Small package",
  • "wieght": 5.7,
  • "width": 10,
  • "height": 20,
  • "depth": 30,
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete package

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

update package

Authorizations:
BearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
id
string
name
string
wieght
number

Weight in kg

width
integer

Width in cm

height
integer

Height in cm

depth
integer

Depth in cm

Responses

Request samples

Content type
application/json
{
  • "id": "5fb4a472-b5fd-4e9a-a4ee-bf42bde86a73",
  • "name": "Small package",
  • "wieght": 5.7,
  • "width": 10,
  • "height": 20,
  • "depth": 30
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Pages

list page

Authorizations:
BearerAuth
query Parameters
object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new page

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string

Name displayed as a page header

slug
required
string

Name used in the URL path

public
boolean

Whether page is visible to unauthorized users

content_html
required
string

HTML formated text to be displayed as a main content under the page header

object (Seo_SeoStore)
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "Terms & Conditions",
  • "slug": "terms-and-conditions",
  • "public": true,
  • "content_html": "<h1>Lorem ipsum dolor sit amet</h1>",
  • "seo": {
    },
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

single page view

Authorizations:
BearerAuth
path Parameters
slug
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

alias

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete page

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

update page

Authorizations:
BearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
name
string

Name displayed as a page header

slug
string

Name used in the URL path

public
boolean

Whether page is visible to unauthorized users

content_html
string

HTML formatted text to be displayed as a main content under the page header

object (Seo_SeoStore)

Responses

Request samples

Content type
application/json
{
  • "name": "Terms & Conditions",
  • "slug": "terms-and-conditions",
  • "public": true,
  • "content_html": "<h1>Lorem ipsum dolor sit amet</h1>",
  • "seo": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

change pages order

Authorizations:
BearerAuth
Request Body schema: application/json
pages
Array of strings

Responses

Request samples

Content type
application/json
{
  • "pages": [
    ]
}

Payments

Update payment status by payment provider

Authorizations:
BearerAuth
path Parameters
payment_method
required
string

Responses

list payment methods

Authorizations:
BearerAuth
query Parameters
shipping_method_id
string
order_code
string
ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new payment method

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
public
boolean
icon
string
url
string

Responses

Request samples

Content type
application/json
{
  • "name": "Heseya Pay",
  • "public": true,
  • "icon": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get payment method

Authorizations:
BearerAuth
query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete payment method

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

update payment method

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
public
boolean
icon
string
url
string

Responses

Request samples

Content type
application/json
{
  • "name": "Heseya Pay",
  • "public": true,
  • "icon": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

list payments

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{}

add new payment

Authorizations:
BearerAuth
Request Body schema: application/json
external_id
string
method_id
string
order_id
string
amount
number
status
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "D2spSDJ21LSA",
  • "method_id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
  • "order_id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
  • "amount": 80.92,
  • "status": "pending"
}

Response samples

Content type
application/json
{}

get payment

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{}

update payment

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
external_id
string
method_id
string
order_id
string
amount
number
status
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "D2spSDJ21LSA",
  • "method_id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
  • "order_id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
  • "amount": 80.92,
  • "status": "pending"
}

Response samples

Content type
application/json
{}

Roles

list of permissions

Authorizations:
BearerAuth
query Parameters
assignable
boolean

Is the permission assignable by current user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

list roles

Authorizations:
BearerAuth
query Parameters
search
string

Full text search

name
string

Name search

description
string

Description search

assignable
boolean

Is the role assignable by current user

object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add a new role

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string

Name of the role

description
string

Description of the role

permissions
Array of strings

Permission names

object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "Admin",
  • "description": "Role with permission to everything",
  • "permissions": [
    ],
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

view the role

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete the role

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

update the role

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the role

description
string

Description of the role

permissions
Array of strings

Permission names

Responses

Request samples

Content type
application/json
{
  • "name": "Admin",
  • "description": "Role with permission to everything",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Products

list products

Authorizations:
BearerAuth
query Parameters
search
string

Full text search

name
string

Name search

slug
string

Slug search

public
boolean

Is public search

full
boolean

Returns details resource

sets[]
string
Example: sets[]=sets[]=category-teapots&sets[]=category-mugs

Product set array slug search

sets_not[]
string
Example: sets_not[]=sets_not[]=category-teapots&sets_not[]=category-mugs

Product set array slug search negation

sort
string
Example: sort=price:asc,created_at:desc,name

Sorting string

tags[]
string
Example: tags[]=tags[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&tags[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Tag array id search

tags_not[]
string
Example: tags_not[]=tags_not[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&tags_not[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Tag array id search negation

available
boolean

Is available search

price.min
number
price.max
number
has_cover
boolean

Product has cover

has_items
boolean

Product has items

has_schemas
boolean

Product has schemas

shipping_digital
boolean

Product has digital shipping

object

search by attributes

object

search by attributes negation

object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Request samples 

await heseya.Products.get(params)

Response samples

Content type
application/json
{
  • "data": [
    ]
}

create product

Authorizations:
BearerAuth
Request Body schema: application/json
object (Metadata)
object (Metadata)
name
required
string
slug
required
string
price
required
number
public
required
boolean
description_html
string
description_short
string
quantity_step
number
vat_rate
number
shipping_digital
required
boolean

Whether product is digital and not delivered by physical means

purchase_limit_per_user
number
media
Array of strings
tags
Array of strings
object
Array of objects
schemas
Array of strings
sets
Array of strings
google_product_category
integer
object (Seo_SeoStore)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "metadata_private": {
    },
  • "name": "string",
  • "slug": "string",
  • "price": 0,
  • "public": true,
  • "description_html": "string",
  • "description_short": "string",
  • "quantity_step": 0,
  • "vat_rate": 0,
  • "shipping_digital": true,
  • "purchase_limit_per_user": 0,
  • "media": [
    ],
  • "tags": [
    ],
  • "attributes": {
    },
  • "items": [
    ],
  • "schemas": [
    ],
  • "sets": [
    ],
  • "google_product_category": 0,
  • "seo": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

single product view

Authorizations:
BearerAuth
path Parameters
slug
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

alias

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete product

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

update product

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
slug
string
price
number
public
boolean
description_html
string
description_short
string
quantity_step
number
vat_rate
number
shipping_digital
boolean

Whether product is digital and not delivered by physical means

purchase_limit_per_user
number
media
Array of strings
tags
Array of strings
object
Array of objects
schemas
Array of strings
sets
Array of strings
google_product_category
integer
object (Seo_SeoStore)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "price": 0,
  • "public": true,
  • "description_html": "string",
  • "description_short": "string",
  • "quantity_step": 0,
  • "vat_rate": 0,
  • "shipping_digital": true,
  • "purchase_limit_per_user": 0,
  • "media": [
    ],
  • "tags": [
    ],
  • "attributes": {
    },
  • "items": [
    ],
  • "schemas": [
    ],
  • "sets": [
    ],
  • "google_product_category": 0,
  • "seo": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Product Sets

/product-sets

Authorizations:
BearerAuth
query Parameters
root
boolean

Return only root lists

tree
boolean

Return sets starting from root with recursively nested children instead of id's

search
string

Full text search

name
string

Name search

slug
string

Slug search

public
boolean

Is public search

parent_id
string
Example: parent_id= 019fc7e8-af32-476f-ba04-068b86833830

UUID of parent set

object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/product-sets

Authorizations:
BearerAuth
query Parameters
tree
boolean

Return set with recursively nested children instead of id's

Request Body schema: application/json
name
required
string

Name displayed to the user

slug_suffix
required
string

Name used in the URL path usually proceeded by parent slug

slug_override
required
boolean

Whether to use slug as suffix to parent or to override the entire slug

public
boolean

Whether set is visible to unauthorized users

description_html
string

HTML formated text to be displayed as a product set description

cover_id
string

Id of media cover

parent_id
string

Id of set, this set belongs to

children_ids
Array of strings

Ids of assigned subsets

object (Seo_SeoStore)
attributes
Array of strings

Array of assigned attributes ids

object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "AGD",
  • "slug_suffix": "agd",
  • "slug_override": true,
  • "public": true,
  • "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
  • "cover_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "children_ids": [
    ],
  • "seo": {
    },
  • "attributes": [
    ],
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/product-sets/{slug}

Authorizations:
BearerAuth
path Parameters
slug
required
string
query Parameters
tree
boolean

Return set with recursively nested children instead of id's

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/product-sets/id:{id}

Authorizations:
BearerAuth
path Parameters
id
required
string
query Parameters
tree
boolean

Return set with recursively nested children instead of id's

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete set with all of it's subsets

Delete set with all of it's subsets

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a

Responses

/product-sets/id:{id}

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a
query Parameters
tree
boolean

Return set with recursively nested children instead of id's

Request Body schema: application/json
name
string

Name displayed to the user

slug_suffix
string

Name used in the URL path usually proceeded by parent slug

slug_override
boolean

Whether to use slug as suffix to parent or to override the entire slug

public
boolean

Whether set is visible to unauthorized users

description_html
string

HTML formated text to be displayed as a product set description

cover_id
string

Id of media cover

parent_id
string

Id of set, this set belongs to

children_ids
Array of strings

Ids of assigned subsets

object (Seo_SeoStore)
attributes
Array of strings

Array of assigned attributes ids

Responses

Request samples

Content type
application/json
{
  • "name": "AGD",
  • "slug_suffix": "agd",
  • "slug_override": true,
  • "public": true,
  • "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
  • "cover_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "children_ids": [
    ],
  • "seo": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/product-sets/reorder

Authorizations:
BearerAuth
Request Body schema: application/json
product_sets
required
Array of strings

Ids of reordered sets

Responses

Request samples

Content type
application/json
{
  • "product_sets": [
    ]
}

/product-sets/reorder/id:{id}

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a
Request Body schema: application/json
product_sets
required
Array of strings

Ids of reordered sets

Responses

Request samples

Content type
application/json
{
  • "product_sets": [
    ]
}

/product-sets/id:{id}/products

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
query Parameters
limit
number

Pagination limit

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/product-sets/id:{id}/products

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a

List of product id's

Request Body schema: application/json
products
Array of strings

Ids of assigned products

Responses

Request samples

Content type
application/json
{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/product-sets/id:{id}/products/reorder

Authorizations:
BearerAuth
query Parameters
id
string

Product set id

Request Body schema: application/json
required
Array of objects

Ids of reordered sets

Responses

Request samples

Content type
application/json
{
  • "products": [
    ]
}

/product-sets/favourites

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/product-sets/favourites

Authorizations:
BearerAuth
Request Body schema: application/json
product_set_id
required
string

Responses

Request samples

Content type
application/json
{
  • "product_set_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete all favourites product sets from logged use

Delete all favourites product sets from logged user

Authorizations:
BearerAuth

Responses

/product-sets/favourites/id:{id}

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a

Product set id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/product-sets/favourites/id:{id}

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a

Product set id

Responses

Schemas

all schemas list

Authorizations:
BearerAuth
query Parameters
name
string
Example: name=test
hidden
boolean
required
boolean
search
string
Example: search=test
sort
string
Example: sort=test
object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

create schema

Authorizations:
BearerAuth
Request Body schema: application/json
type
string
Enum: "string" "numeric" "boolean" "date" "select" "file" "multiply" "multiply_schema"
name
string
description
string
price
number
hidden
boolean
required
boolean
min
string
max
string
step
string
default
string
pattern
string
validation
string
shipping_time
integer
shipping_date
string <date-time>
Array of objects
used_schemas
Array of strings

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "name": "Size",
  • "description": "string",
  • "price": 9.99,
  • "hidden": true,
  • "required": true,
  • "min": "string",
  • "max": "string",
  • "step": "string",
  • "default": "string",
  • "pattern": "string",
  • "validation": "string",
  • "shipping_time": 5,
  • "shipping_date": "2021-09-13T11:11",
  • "options": [
    ],
  • "used_schemas": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/schemas/id:{id}

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/schemas/id:{id}

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

update schema

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
type
string
Enum: "string" "numeric" "boolean" "date" "select" "file" "multiply" "multiply_schema"
name
string
description
string
price
number
hidden
boolean
required
boolean
min
string
max
string
step
string
default
string
pattern
string
validation
string
shipping_time
integer
shipping_date
string <date-time>
Array of objects
used_schemas
Array of strings

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "name": "Size",
  • "description": "string",
  • "price": 9.99,
  • "hidden": true,
  • "required": true,
  • "min": "string",
  • "max": "string",
  • "step": "string",
  • "default": "string",
  • "pattern": "string",
  • "validation": "string",
  • "shipping_time": 5,
  • "shipping_date": "2021-09-13T11:11",
  • "options": [
    ],
  • "used_schemas": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

SEO

/seo

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update or create global SEO

Authorizations:
BearerAuth
Request Body schema: application/json
title
string

Displayed seo title

description
string

Displayed SEO description

keywords
Array of strings

List of SEO keywords

twitter_card
string
Enum: "summary" "summary_large_image"
no_index
boolean

Whether seo indexing is disabled

og_image_id
string

Responses

Request samples

Content type
application/json
{
  • "title": "Title",
  • "description": "Description SEO",
  • "keywords": [
    ],
  • "twitter_card": "summary",
  • "no_index": true,
  • "og_image_id": "0006c3a0-21af-4485-b7fe-9c42233cf03"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/seo/check

Authorizations:
BearerAuth
Request Body schema: application/json
keywords
required
Array of strings

List of SEO keywords

object

Model excluded from keywords checking

Responses

Request samples

Content type
application/json
{
  • "keywords": [
    ],
  • "excluded": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Settings

list settings

Authorizations:
BearerAuth
query Parameters
array
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new setting

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string

Setting name

value
required
string

Setting value

public
required
boolean

Whether setting is public

Responses

Request samples

Content type
application/json
{
  • "name": "store_name",
  • "value": "Heseya",
  • "public": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

view setting

Authorizations:
BearerAuth
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete setting

Authorizations:
BearerAuth
path Parameters
name
required
string

Responses

update setting

Authorizations:
BearerAuth
path Parameters
name
required
string
Request Body schema: application/json
name
required
string

Setting name

value
required
string

Setting value

public
required
boolean

Whether setting is public

Responses

Request samples

Content type
application/json
{
  • "name": "store_name",
  • "value": "Heseya",
  • "public": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Statuses

list statuses

Authorizations:
BearerAuth
query Parameters
object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new status

Authorizations:
BearerAuth
Request Body schema: application/json
id
string
name
string
color
string
cancel
boolean
description
string
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "name": "Cancel",
  • "color": "8f022c",
  • "cancel": true,
  • "description": "Your order has been cancelled!",
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete status

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

update status

Authorizations:
BearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
id
string
name
string
color
string
cancel
boolean
description
string

Responses

Request samples

Content type
application/json
{
  • "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "name": "Cancel",
  • "color": "8f022c",
  • "cancel": true,
  • "description": "Your order has been cancelled!"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reorder statuses

Authorizations:
BearerAuth
Request Body schema: application/json
statuses
Array of strings

Responses

Request samples

Content type
application/json
{
  • "statuses": [
    ]
}

Tags

list tags

Authorizations:
BearerAuth
query Parameters
search
string

Full text search

name
string

Name search

color
string

Color search

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new tag

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
color
string

Responses

Request samples

Content type
application/json
{
  • "name": "Sale",
  • "color": 111111
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete tag

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4

Responses

update tag

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4
Request Body schema: application/json
name
string
color
string

Responses

Request samples

Content type
application/json
{
  • "name": "Sale",
  • "color": 111111
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Users

user list

Authorizations:
BearerAuth
query Parameters
search
string

Full text search

name
string

Name search

email
string
Example: email=email@example.com

Email search

roles[]
string
Example: roles[]=9e2206ff-1edf-49c4-ab6c-ab620f18b98d

Search for users in roles by role id

consent_name
string

Accepted Consent name search

consent_id
string
Example: consent_id=9e2206ff-1edf-49c4-ab6c-ab620f18b98d

Accepted Consent id search

sort
string
Example: sort=name:desc

Sorting string

full
boolean

Returns details resource

limit
number
Example: limit=12

Number of elements per page

object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new user

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
email
string
password
string
birthday_date
string <date>
phone
string
roles
Array of strings

Ids of assigned roles

object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "Marianna Szulc",
  • "email": "admin@example.com",
  • "password": "123@@#abYZ",
  • "birthday_date": "2000-01-01",
  • "phone": "+48123456789",
  • "roles": [
    ],
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

user view

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete user

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0

Responses

update user

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
name
string
email
string
birthday_date
string <date>
phone
string
roles
Array of strings

Ids of assigned roles

Responses

Request samples

Content type
application/json
{
  • "name": "Marianna Szulc",
  • "email": "admin@example.com",
  • "birthday_date": "2000-01-01",
  • "phone": "+48123456789",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Metadata

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create/update/delete metadata

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0
Request Body schema: application/json
faktura
string

Responses

Request samples

Content type
application/json
{
  • "faktura": "FV/2022/03/10/005"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attributes

list attributes

Authorizations:
BearerAuth
query Parameters
search
string

Full text search

global
boolean

search by global flag

object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

name
string

Name search

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new attribute

Authorizations:
BearerAuth
Request Body schema: application/json
id
string
name
string

Name of attribute

slug
string

Slug of name attribute

description
string

Description of attribute

min
integer

Lowest value from options

max
integer

Highest value from options

type
integer

Type of attribute

global
boolean

Possibility to use attribute in search

sortable
boolean

Parameter for storefront

object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "name": "Screen size",
  • "slug": "screen-size",
  • "description": "Presented number is size of screen monitor",
  • "min": "22",
  • "max": "27",
  • "type": 1,
  • "global": true,
  • "sortable": true,
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get attribute

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete attribute

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

update attribute

Authorizations:
BearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
id
string
name
string

Name of attribute

slug
string

Slug of name attribute

description
string

Description of attribute

min
integer

Lowest value from options

max
integer

Highest value from options

type
integer

Type of attribute

global
boolean

Possibility to use attribute in search

sortable
boolean

Parameter for storefront

Responses

Request samples

Content type
application/json
{
  • "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "name": "Screen size",
  • "slug": "screen-size",
  • "description": "Presented number is size of screen monitor",
  • "min": "22",
  • "max": "27",
  • "type": 1,
  • "global": true,
  • "sortable": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get list of all options attribute

Authorizations:
BearerAuth
path Parameters
id
required
integer
query Parameters
object

search by metadata

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add new option to attribute

Authorizations:
BearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
id
string
name
string

Name of attribute option

index
integer

Index of attribute option

value_number
number

Number value attribute option

value_date
string <date>

Date value attribute option

attribute_id
string
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "name": "Screen size",
  • "index": 1,
  • "value_number": "27",
  • "value_date": "2022-02-22",
  • "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

update option

Authorizations:
BearerAuth
path Parameters
attribute_id
required
string
option_id
required
string
Request Body schema: application/json
id
string
name
string

Name of attribute option

index
integer

Index of attribute option

value_number
number

Number value attribute option

value_date
string <date>

Date value attribute option

attribute_id
string

Responses

Request samples

Content type
application/json
{
  • "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
  • "name": "Screen size",
  • "index": 1,
  • "value_number": "27",
  • "value_date": "2022-02-22",
  • "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete option

Authorizations:
BearerAuth
path Parameters
attribute_id
required
integer
option_id
required
integer

Responses

Consents

list consents

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

add new consent

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
description_html
string
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Consent One",
  • "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
  • "required": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get consent

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delete consent

Authorizations:
BearerAuth
path Parameters
id
required
integer

Responses

update consent

Authorizations:
BearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
name
string
description_html
string
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Consent One",
  • "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
  • "required": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Banners

displaying banners

Authorizations:
BearerAuth
query Parameters
slug
string
Example: slug=spring-banner
object (MetadataQuery)

search by metadata

object (MetadataQuery)

search by metadata private

ids[]
string
Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557

Ids array search

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

adding new banner

Authorizations:
BearerAuth
Request Body schema: application/json
slug
string
name
string
active
boolean
Array of objects (BannerMedia)
object (Metadata)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "slug": "spring-banner",
  • "name": "Spring banner",
  • "active": true,
  • "banner_media": [],
  • "metadata": {
    },
  • "metadata_private": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get specific banner

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update banner

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
slug
string
name
string
active
boolean
Array of objects (BannerMedia)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

update banner

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

get specific banner by slug

Authorizations:
BearerAuth
path Parameters
slug
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Google Categories

google category list

Authorizations:
BearerAuth
query Parameters
lang
string
Example: lang=pl-PL

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Wishlist

displaying wishlist products

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

adding new product to wishlist

Authorizations:
BearerAuth
Request Body schema: application/json
product_id
string

Responses

Request samples

Content type
application/json
{
  • "product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Remove all user wishlist products

Authorizations:
BearerAuth

Responses

get wishlist product

Authorizations:
BearerAuth
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

soft delete product from wishlist

Authorizations:
BearerAuth
path Parameters
product_id
required
string

Responses